feat: update environment variables to use javascript-based config #249
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #249 +/- ##
=======================================
Coverage 96.36% 96.36%
=======================================
Files 194 194
Lines 1841 1841
Branches 324 324
=======================================
Hits 1774 1774
Misses 62 62
Partials 5 5 ☔ View full report in Codecov by Sentry. |
jsnwesson
force-pushed
the
jwesson/update-to-jsbased-config
branch
from
3c9e525 to
dfbdb59
Compare
jsnwesson
commented
Nov 30, 2023
jsnwesson
force-pushed
the
jwesson/update-to-jsbased-config
branch
from
779f0a4 to
2ba72d9
Compare
jsnwesson
force-pushed
the
jwesson/update-to-jsbased-config
branch
from
2ba72d9 to
f041d35
Compare
jsnwesson
force-pushed
the
jwesson/update-to-jsbased-config
branch
from
562e24a to
ec4e9e8
Compare
MaxFrank13
reviewed
Dec 1, 2023
src/setupTest.jsx
Outdated
| /* | ||
| When .env.test is removed, uncomment the env vars below and add any environment variables for testing with Jest | ||
|
|
||
| Context: Snapshot is not currently not set up to be able to parse the environment variables in env.config.js |
There was a problem hiding this comment.
Suggested change
| Context: Snapshot is not currently not set up to be able to parse the environment variables in env.config.js | |
| Context: Snapshot is not currently set up to be able to parse the environment variables in env.config.js |
The word "not" is repeated to make this a double negative
MaxFrank13
reviewed
Dec 1, 2023
Comment on lines
+2
to
+17
| Learner Dashboard is now able to handle JS-based configuration! | ||
|
|
||
| For the time being, the `.env.*` files are still made available when cloning down this repo or pulling from | ||
| the master branch. To switch to using `env.config.js`, make a copy of `example.env.config.js` and configure as needed. | ||
|
|
||
| For testing with Jest Snapshot, there is a mock in `/src/setupTest.jsx` for `getConfig` that will need to be | ||
| uncommented. | ||
|
|
||
| Note: having both .env and env.config.js files will follow a predictable order, in which non-empty values in the | ||
| JS-based config will overwrite the .env environment variables. | ||
|
|
||
| frontend-platform's getConfig loads configuration in the following sequence: | ||
| - .env file config | ||
| - optional handlers (commonly used to merge MFE-specific config in via additional process.env variables) | ||
| - env.config.js file config | ||
| - runtime config |
There was a problem hiding this comment.
🙌 Thank you for adding this valuable context
MaxFrank13
approved these changes
Dec 4, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context:
In order to use Frontend Plugin Framework Library, every Host MFE needs to use a javascript-based configuration. Most of the groundwork was done in frontend-platform and frontend-build to allow for js-based configs to be used in MFEs, and Learner Dashboard will be the first to make this transformation.
In place of the
.env.*files would be aenv.config.jsfile that includes all of the variables that would have existed in.env.development. Anexample.env.config.jshas been added and can be copied.When a team or developer makes the switch from
.env.*toenv.config.js, any env vars needed for testing with Jest Snapshot will need to be included insrc/setupTest.jsx.Note: the
.env.*files are not being deleted and a future date/announcement will be made when the master branch of Learner Dashboard no longer provides a.envfile.